docs/Migrating from baseflight.md

   1 # Migrating from baseflight
   2
   3 ## Procedure
   4
   5 **First ensure your main flight battery is disconnected or your props are off!**
   6
   7 Before flashing with cleanflight, dump your configs for each profile via the CLI and save to a text file.
   8
   9 ```
  10 profile 0
  11 dump
  12 profile 1
  13 dump
  14 profile 2
  15 dump
  16 ```
  17
  18 Then after flashing cleanflight paste the output from each dump command into the cli, switching profiles as you go.
  19
  20 You'll note that some commands are not recognised by cleanflight when you do this.  For the commands that are not recognised look
  21 up the new configuration options and choose appropriate values for the settings.  See below for a list of differences.
  22
  23 Once you've done this for the first profile, save the config.  Then verify your config is OK, e.g. features serial ports, etc.
  24 When you've verified the first profile is OK repeat for the other profiles.
  25
  26 It's also advisable to take screenshots of your AUX settings from baseflight configurator and then after re-applying the settings
  27 verify your aux config is correct - aux settings are not backwards compatible.
  28
  29 ## CLI command differences from baseflight
  30
  31 In general all CLI commands use underscore characters to separate words for consistency.  In baseflight the format of CLI commands is somewhat haphazard.
  32
  33 ### gps_baudrate
  34 reason: simplify
  35
  36 Cleanflight uses normal baud rate values for gps baudrate, baseflight uses an index.
  37
  38 If an unsupported baud rate value is used the gps code will select 115200 baud.
  39
  40 example: `set gps_baudrate = 115200`
  41
  42
  43 ### gps_type
  44 reason: renamed to `gps_provider` for consistency
  45
  46 ### serialrx_type
  47 reason: renamed to `serialrx_provider` for consistency
  48
  49 ### rssi_aux_channel
  50 reason: improved functionality
  51
  52 Cleanflight supports using any RX channel for rssi.  Baseflight only supports AUX1 to 4.
  53
  54 In Cleanflight a value of 0 disables the feature, a higher value indicates the channel number to read RSSI information from.
  55
  56 Example: to use RSSI on AUX1 in Cleanflight use `set rssi_aux_channel = 5`, since 5 is the first AUX channel.
  57
  58 ### failsafe_detect_threshold
  59 reason: improved functionality
  60
  61 See `failsafe_min_usec` and `failsafe_max_usec` in Failsafe documentation.
  62
  63 ### emfavoidance
  64 reason: renamed to `emf_avoidance` for consistency
  65
  66 ### yawrate
  67 reason: renamed to `yaw_rate` for consistency
  68
  69 ### yawdeadband
  70 reason: renamed to `yaw_deadband` for consistency
  71
  72 ### midrc
  73 reason: renamed to `mid_rc` for consistency
  74
  75 ### mincheck
  76 reason: renamed to `min_check` for consistency
  77
  78 ### maxcheck
  79 reason: renamed to `max_check` for consistency
  80
  81 ### minthrottle
  82 reason: renamed to `min_throttle` for consistency
  83
  84 ### maxthrottle
  85 reason: renamed to `max_throttle` for consistency
  86
  87 ### mincommand
  88 reason: renamed to `min_command` for consistency
  89
  90 ### deadband3d_low
  91 reason: renamed to `3d_deadband_low` for consistency
  92
  93 ### deadband3d_high
  94 reason: renamed to `3d_deadband_high` for consistency
  95
  96 ### deadband3d_throttle
  97 reason: renamed to `3d_deadband_throttle` for consistency
  98
  99 ### neutral3d
 100 reason: renamed to `3d_neutral` for consistency
 101
 102 ### alt_hold_throttle_neutral
 103 reason: renamed to `alt_hold_deadband` for consistency